13.1 申请发送SPA安全码

基本信息 申请发送SPA安全码,为某个用户申请SPA安全码,已经存在安全码,直接发送,没有的生成新的安全码,过期的续期安全码,且以短信或者邮件形式分发下去( 注:当前暂时只支持短信发送

Path: /api/v1/spa/sendSpaCode

Method: POST

接口描述:

  1. 校验传入的用户信息,匹配则发送安全码短信给终端用户,不匹配则返回用户不存在。
  2. 接口适用于 v2.2.10 及以上版本。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

名称 类型 是否必须 默认值 备注
name string 非必须 用户名
displayName string 非必须 用户显示名
phone string 非必须 手机号码
email string 非必须 邮箱
userDirectoryName string 必须 用户所在目录名
expiredTime string 非必须 0:永不过期 过期时间,时间戳,10位长度,单位秒
sendMode string[] 非必须 ["sms"] 发送模式(sms,email)

使用说明:

  • name/displayName/phone/email:四个属性至少传一个
  • userDirectoryName: 用户所在目录名( 必须传用户所在目录名
  • expiredTime: 过期时间,时间戳,10位长度,单位秒,默认值0(永不过期),如不传则重置时默认0
  • sendMode: 发送模式:sms (短信发送),email(邮件发送,暂不支持)

业务逻辑说明:

  • 当用户属性字段(name、displayName、phone、email)不为空时,会对其进行联合查询。
    • 举例:
      • 若仅传了name,则aTrust会使用name查询对应用户,找到则使用已配置的分发服务器发送安全码(安全码不存在则生成,安全码过期则续期),未找到则报错。
      • 若同时传了name和phone时,会通过name和phone联合查询对应的用户,找到则使用已配置的分发服务器发送安全码(安全码不存在则生成,安全码过期则续期),未找到则报错。
      • 依次类推!
  • 找到多个用户则为多个用户发送安全码
    • 举例:
      • 若仅传了一个手机号,查找到多个用户则为这些用户都发送安全码
**注:当前暂时只支持短信发送**

请求示例

{
    "name": "111111",
    "phone": "15212345679",
    "userDirectoryName": "xxx",
    "expiredTime":"0",
    "sendMode":["sms"]
}

返回数据

名称 类型 是否必须 备注
code number 必须 返回编码 0 成功 其它值,失败
data object 必须
msg string 必须 code对应的提示信息

返回示例

{
    "code": 0,
    "data": {
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户不存在 10000021
当前安全码为共享码模式, 无法进行此操作, 请先更改安全码模式并保存后重试 10000022
未找到配置的安全码分发网关 10000022
用户已过期 10000023
用户被禁用 10000024
参数类型schema校验失败 7201
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-09-05 14:20

results matching ""

    No results matching ""